Pyramid includes a robust library of API functions to allow customers to programmatically access and manage the application. The APIs are exposed through REST using the OpenAPI 2.0 standard, and can be used from any programming environment that supports standard REST calls. To complement the REST API implementation, client SDK libraries in various languages are available as of API version 3, Older API versions are operational through REST endpoints only.
Versions
The APIs has come in 3 versions.
- Version 3.0 BETA (from 2023.10 onwards) covers the same functionality as v2 but has been extended with new functions; a different REST implementation; and the addition of client SDK libraries in other languages.
- Version 2.0 (from 2018.05 onwards) covers the same functionality as v1, but has been simplified and extended. This version will be deprecated at the end of 2024.
- Version 1.0 (up to 2018.04) covers core functionality - but has been fully deprecated.
To see help for API version 1, see older versions of API help.
Function List
The API functions cover a variety of core functions, covering authentication and access, administration and content operations. Where relevant, objects needed to implement these functions are described in a separate definitions list.
API 3.0 BETA
- Authentication Index - generating access tokens
- Access Index - security and system access operations
- Content Index - content management and operations
- Analytics Index - query and analytic content creation
- Data Sources Index - data source management and operations
- Tasks Index - task operations
- Notifications Index - notification details
- Themes Index - theme operations
Note: API3 is subject to breaking changes until it is officially released.
API 2.0
- Authentication Index - logging into the application programmatically
- Access Index - security and system access operations
- Content Index - content management and operations
- Query Index - query execution
- Data Sources Index - data source management and operations
- Tasks Index - task operations
- Notifications Index - notification details
- Themes Index - theme import / export
Object Definitions
- Object Definitions Index - all objects and classes used in the API calls and responses.
Using REST and the SDKs
Both the REST APIs and SDKs are built using the Swagger OpenAPI standard.
- REST: The implementation of the REST framework follows the general approach of all HTTP based APIs. However, there is a difference between versions 1 and 2 compared to version 3 - mainly centered around the mechanics of handling security tokens and error responses. Click here for more details on using REST.
- SDKs: The client SDKs are currently offered in C#, JAVA, JavaScript / TypeScript, Python and PHP. Click here for more details on using the SDKs.
Examples and Code Snippets
Examples can be found in the documentation covering a variety of the methods in the API. The methods with examples are highlighted on the main section ('namespace') pages above.
For API 3, code snippets for each function are also shown for each client SDK library.